Skip to content

cluster, diffimg, dijkstra, dotty, gvedit, gvgen, gvmap: add page #18502

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 36 commits into
base: main
Choose a base branch
from
Open

cluster, diffimg, dijkstra, dotty, gvedit, gvgen, gvmap: add page #18502

wants to merge 36 commits into from
+153 −0

Conversation

Kabiirk
Copy link

@Kabiirk Kabiirk commented Oct 6, 2025 •
edited
Loading

Hi!

W.r.t issue #2580 , I've added the commands cluster, diffimg, dijkstra, dotty, gvedit, gvgen, gvmap. A few notes:

  1. As per Graphviz documentation, dotty graph editor has been deprecated. I've highlighted this in dotty's documentation as a separate Note. (I think people now use gvedit or any other online service for this)
  2. These commands can be run on multiple platforms (Mac, Windows, Linux etc.) hence, I've put them in the pages/common/ directory as per convention.

Let me know if there are any other code changes/modalities required from my side.

P.S.
Also, please clarify if I need to agree to the the CLA for tldr-pages/tldr as well.

  • The page(s) are in the correct platform directories: common, linux, osx, windows, sunos, android, etc.
  • The page(s) have at most 8 examples.
  • The page description(s) have links to documentation or a homepage.
  • The page(s) follow the content guidelines.
  • The page(s) follow the style guide.
  • The PR title conforms to the recommended templates.

@CLAassistant
Copy link

CLAassistant commented Oct 6, 2025 •
edited
Loading

CLA assistant check
All committers have signed the CLA.

@github-actions github-actions bot added mass changes Changes that affect multiple pages. new command Issues requesting creation of a new page or PRs adding a new page for a command. review needed Prioritized PRs marked for reviews from maintainers. labels Oct 6, 2025
@tldr-bot
Copy link

tldr-bot commented Oct 6, 2025

The build for this PR failed with the following error(s) at commit
7fafd8488fd7925dc26e8b494411a6f8480dba18:

pages/common/cluster.md:25:25 MD047/single-trailing-newline Files should end with a single newline character
pages/common/dijkstra.md:21:34 MD047/single-trailing-newline Files should end with a single newline character
pages/common/dotty.md:22:41 MD047/single-trailing-newline Files should end with a single newline character
pages/common/gvedit.md:21:11 MD047/single-trailing-newline Files should end with a single newline character
pages/common/gvgen.md:33:10 MD047/single-trailing-newline Files should end with a single newline character
pages/common/gvmap.md:29:56 MD047/single-trailing-newline Files should end with a single newline character
pages/common/cluster.md:1: TLDR009 Page should contain a newline at end of file
pages/common/dijkstra.md:1: TLDR009 Page should contain a newline at end of file
pages/common/dotty.md:1: TLDR009 Page should contain a newline at end of file
pages/common/gvedit.md:1: TLDR009 Page should contain a newline at end of file
pages/common/gvgen.md:1: TLDR009 Page should contain a newline at end of file
pages/common/gvmap.md:1: TLDR009 Page should contain a newline at end of file

Please fix the error(s) and push again.

@Kabiirk Kabiirk changed the title Doc adding more graphviz commands cluster, diffimg, dijkstra, dotty, gvedit, gvgen, gvmap: add page Oct 6, 2025
Managor
Managor requested changes Oct 6, 2025
View reviewed changes
Copy link
Member

@Managor Managor left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll let it slide this time, but next time limit the new page count in a PR to 5 to make it less taxing to review

@Kabiirk
Copy link
Author

Kabiirk commented Oct 6, 2025

@Managor, Thanks for your review, I've incorporated all changes except one, I require your inputs on changes to pages/common/gvedit.md.

Understood, I'll keep the page limit in mind for future PRs. I suggest you add this to the content guidelines.

Managor
Managor requested changes Oct 7, 2025
View reviewed changes
Copy link
Member

@Managor Managor left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mnemonics allow the user to memorize what the option is short for. https://github.com/tldr-pages/tldr/blob/main/contributing-guides/style-guide.md#short-option-mnemonics

Kabiirk and others added 9 commits October 6, 2025 20:49
Managor
Managor requested changes Oct 7, 2025
View reviewed changes
Managor
Managor requested changes Oct 7, 2025
View reviewed changes
@Managor Managor mentioned this pull request Oct 7, 2025
Open
41 tasks
@Kabiirk
Copy link
Author

Kabiirk commented Oct 7, 2025

@Managor, Thanks for your detailed suggestions & prompt approval!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Managor Managor Managor approved these changes

At least 2 approving reviews are required to merge this pull request.

Assignees
No one assigned
Labels
mass changes Changes that affect multiple pages. new command Issues requesting creation of a new page or PRs adding a new page for a command. review needed Prioritized PRs marked for reviews from maintainers.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@Kabiirk @CLAassistant @tldr-bot @Managor